/** 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package it.free.i.virtual.machine.hal.devicealias.echo;

import it.free.i.virtual.machine.hal.devicealias.command.DeviceAliasPortCommand;
import it.free.i.virtual.machine.hal.devicealias.laboratory.positioningsystem.physics.CenterOfMassPosition;
import it.free.i.virtual.machine.hal.devicealias.laboratory.positioningsystem.physics.LinearVelocity;

/**
 * Positioning data DTO
 * @author stefano
 */
public interface PositionEcho extends Echo {

	/**
	 * Retrieve the center of mass position 
	 * @return the centerOfMassPosition
	 */
	public CenterOfMassPosition getCenterOfMassPosition();

	/**
	 * Set the center of mass position
	 * @param centerOfMassPosition the centerOfMassPosition to set
	 */
	public void setCenterOfMassPosition(CenterOfMassPosition centerOfMassPosition);

	/**
	 * Get the linear velocity
	 * @return the linearVelocity
	 */
	public LinearVelocity getLinearVelocity();

	/**
	 * Set the linear velocity
	 * @param linearVelocity the linearVelocity to set
	 */
	public void setLinearVelocity(LinearVelocity linearVelocity);
	
	/**
	 * Set the command that caused this response to be generated
	 * @param deviceAliasPortCommand is the source do read command
	 */
	public void setInitiaLDeviceAliasPortCommand(DeviceAliasPortCommand deviceAliasPortCommand);
	
	/**
	 * Get the command that caused this response to be generated
	 * @return source command that caused the do read operation
	 */
	public DeviceAliasPortCommand getInitiaLDeviceAliasPortCommand();
	
}
